Document indexOf return value when not found #60569
Open
+24
−24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
typescript-bot
added
the
For Uncommitted Bug
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
|
@microsoft-github-policy-service agree |
RyanCavanaugh
approved these changes
Nov 27, 2024
|
note that i didn't get the tests to pass. i experimented a bit locally and to me it seemed like the process is to copy over the generated files as the new baseline references, but even after doing that the tests still didn't pass. does anyone know how i get the test runner to print the actual diffs rather than just fail the test? |
|
See https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md#managing-the-baselines You'd just need to run the tests and then run the "baseline-accept" task. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #60570
The documentation for
indexOfon arrays already mentioned that the method returns -1 when the value is not found:But for strings, this information was missing thus far:
Of course the user would have been able to puzzle this together by seeing that the return type is just
number, not something likenumber | undefined, thus allowing them to figure out that the sentinel value probably must be -1. Nevertheless, having to stop and think about this is unnecessary friction for people who don't remember this fact by heart, for example people who jump between programming languages a lot.I also noticed that the same information was missing for all the
TypedArrays, so I went ahead and extended the docs there as well.